Investigator API

POST Saved Search

POST Saved Search

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

Creates a new saved search.

OperationId: POST Saved Search

Authorization Method(s): OAuth

Verb: POST

End Point: /api/configuration/user/savedsearch

Request Body

OVERVIEW

Request Model

Display Name	Field Name	Field Type
Name	name	string
Notes	notes	string
Search	search	SearchDto
Folder Id	folderId	integer

SearchDto

Display Name	Field Name	Field Type
Search By	searchBy	SearchBy
Rate Changes Search By	rateChangesSearchBy	RateChangesSearchBy
Taxability Changes Search By	taxabilityChangesSearchBy	CommonSearchBy
Taxability Matrix Search By	taxabilityMatrixSearchBy	TaxMatrixSearchBy
Rate Directory Search By	rateDirectorySearchBy	RateDirectorySearchBy
Search Type	searchType	SearchType

SearchBy

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Parameters	parameters	SearchParameters
Filters	filters	SearchFilters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

SearchParameters

Display Name	Field Name	Field Type
Postal Code	postalCode	string
Npanxx	npanxx	string
Location Id	locationId	string
Address	address	Address
State County City	stateCountyCity	StateCountyCity
As Of Date	asOfDate	string
Geocode	geocode	string

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

SearchFilters

Display Name	Field Name	Field Type
Customer Usage Type	customerUsageType	string
Provider Type	providerType	providerTypes
List Items By	listItemsBy	SearchListItemsBy
Product Group	productGroup	string
Product Item	productItem	string
Sku	sku	string

SearchListItemsBy

Display Name	Field Name	Field Type

RateChangesSearchBy

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Filters	filters	RateChangesFilters
Parameters	parameters	RateChangesSearchParameters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

RateChangesFilters

Display Name	Field Name	Field Type
Customer Usage Type	customerUsageType	string
Provider Type	providerType	providerTypes
Start Date	startDate	DataYearMonth
End Date	endDate	DataYearMonth
Release Number	releaseNumber	integer
Date Type	dateType	RateChangesDateType

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

RateChangesDateType

Display Name	Field Name	Field Type

RateChangesSearchParameters

Display Name	Field Name	Field Type
Pgpis	pgpis	array[Pgpi]
Postal Code	postalCode	string
Npanxx	npanxx	string
Locations	locations	array[]
Address	address	Address
State County City	stateCountyCity	StateCountyCity
Geocode	geocode	string
By	by	SearchListItemsBy
Skus	skus	array[]

Pgpi

Display Name	Field Name	Field Type
Product Group	productGroup	string
Product Item	productItem	string

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

SearchListItemsBy

Display Name	Field Name	Field Type

CommonSearchBy

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Filters	filters	CommonSearchFilters
Parameters	parameters	CommonSearchParameters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

CommonSearchFilters

Display Name	Field Name	Field Type
Customer Usage Type	customerUsageType	string
Provider Type	providerType	providerTypes
Start Date	startDate	DataYearMonth
End Date	endDate	DataYearMonth
Release Number	releaseNumber	integer
Date Type	dateType	SearchDateType

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

SearchDateType

Display Name	Field Name	Field Type

CommonSearchParameters

Display Name	Field Name	Field Type
Pgpis	pgpis	array[Pgpi]
Postal Code	postalCode	string
Npanxx	npanxx	string
Locations	locations	array[]
Address	address	Address
State County City	stateCountyCity	StateCountyCity
Geocode	geocode	string
By	by	SearchListItemsBy
Skus	skus	array[]

Pgpi

Display Name	Field Name	Field Type
Product Group	productGroup	string
Product Item	productItem	string

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

SearchListItemsBy

Display Name	Field Name	Field Type

TaxMatrixSearchBy

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Filters	filters	TaxMatrixSearchFilters
Parameters	parameters	CommonSearchParameters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

TaxMatrixSearchFilters

Display Name	Field Name	Field Type
Customer Usage Type *	customerUsageType	string
Provider Type *	providerType	providerTypes
As Of Date	asOfDate	DataYearMonth
Release Number	releaseNumber	integer
Date Type	dateType	SearchDateType

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

SearchDateType

Display Name	Field Name	Field Type

CommonSearchParameters

Display Name	Field Name	Field Type
Pgpis	pgpis	array[Pgpi]
Postal Code	postalCode	string
Npanxx	npanxx	string
Locations	locations	array[]
Address	address	Address
State County City	stateCountyCity	StateCountyCity
Geocode	geocode	string
By	by	SearchListItemsBy
Skus	skus	array[]

Pgpi

Display Name	Field Name	Field Type
Product Group	productGroup	string
Product Item	productItem	string

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

SearchListItemsBy

Display Name	Field Name	Field Type

RateDirectorySearchBy

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Filters	filters	RateDirectorySearchFilters
Parameters	parameters	RateDirectorySearchParameters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

RateDirectorySearchFilters

Display Name	Field Name	Field Type
Release Number	releaseNumber	integer
Date Type	dateType	SearchDateType

SearchDateType

Display Name	Field Name	Field Type

RateDirectorySearchParameters

Display Name	Field Name	Field Type
Geocode	geocode	string
Locations	locations	array[]
Postal Code	postalCode	string
Npanxx	npanxx	string
State County City	stateCountyCity	StateCountyCity
State	state	States
As Of Date	asOfDate	DataYearMonth
Address	address	Address
Current Page	currentPage	integer
Page Size	pageSize	integer

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

States

Display Name	Field Name	Field Type
State	state	string

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

SearchType

Display Name	Field Name	Field Type

Request Headers

Display String	Field Name	Field Type
User Name	userName	string

Query Parameters

Display String	Field Name	Field Type
Api-version*	api-version	undefined

*Mandatory parameter

ProblemDetails

OVERVIEW

Overview

ProblemDetails

Display Name	Field Name	Field Type
Type	type	string
Title	title	string
Status	status	integer
Detail	detail	string
Instance	instance	string

Response Codes

code	description
201	Returns the created saved search.
401	If the user is unauthorized.
400	If the input is invalid.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:/api/configuration/user/savedsearch

Add Request Headers:

Add Header

Try It Out

Enter Environment Credentials

OK